Request For Return Outbound

The ReturnRequest API enables to request for returning the outbound transaction payment.

Method: POST

{{URL}}/rtp/rpc/TransactionService/ReturnRequest

Headers

Name	Value
Content-Type	application/json
Credential	"Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmN5NWQxY2RlNDE5"
Signature	"{{signature}}"

Example

Payload Parameters

Parameter	Description
referenceNumber Mandatory	String Reference number of the original transaction Example – "M202311099876665149078836456"
processor Mandatory	String Payment channel through which the transaction happens Example – "TCH" or "FedNow"
caseId Mandatory (Applicable only for FedNow)	String Case ID that comes in inbound request Example – "RRCASEQA202308160000000002"
_caseId Mandatory (Applicable only for TCH)	String Case ID that comes in inbound request Example – "CASE91000072"
reason Mandatory	Object
code Mandatory	String Reason code for return request Example – "AC03"
additionalInfo Mandatory	String Additional information for return request Example – "Test Information"
returnRequestDetails Optional (Applicable only for FedNow)	Object
email Optional	String Email of the user who handles this request Example – "ramesh@test.com"
name Optional	String Name of the user who handles this request Example – "Ramesh P"
phoneNo Optional	String Contact phone number of the user who handles this request Example – "+19-856475852"
prefMethod Optional	String Preferable contact option code Example – "PHON"

cURL

curl --location '{{URL}}/rtp/rpc/TransactionService/ReturnRequest' \
--header 'Content-Type: application/json' \
--data '{"referenceNumber":"M202311099876665149078836456","processor":"TCH","_caseId":"CASE91000072","reason":{"code":"AC03","additionalInfo":"Test Information"}}'

C#

var options = new RestClientOptions("{{URL}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/rtp/rpc/TransactionService/ReturnRequest", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""referenceNumber"": ""M202311099876665149078836456"",
" + "\n" +
@"    ""processor"": ""TCH"",
" + "\n" +
@"    ""_caseId"": ""CASE91000072"",
" + "\n" +
@"    ""reason"": {
" + "\n" +
@"        ""code"": ""AC03"",
" + "\n" +
@"        ""additionalInfo"": ""Test Information""
" + "\n" +
@"    }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "{{URL}}/rtp/rpc/TransactionService/ReturnRequest"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
    "referenceNumber": "M202311099876665149078836456",`+"
"+`
    "processor": "TCH",`+"
"+`
    "_caseId": "CASE91000072",`+"
"+`
    "reason": {`+"
"+`
        "code": "AC03",`+"
"+`
        "additionalInfo": "Test Information"`+"
"+`
    }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/rtp/rpc/TransactionService/ReturnRequest',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "referenceNumber": "M202311099876665149078836456",
  "processor": "TCH",
  "_caseId": "CASE91000072",
  "reason": {
    "code": "AC03",
    "additionalInfo": "Test Information"
  }
});

req.write(postData);

req.end();

Request Body (Applicable for both FedNow and TCH)

{
    "referenceNumber": "M202311099876665149078836456",
    "processor": "TCH",
    "caseId": "RRCASEQA202308160000000002", //applicable only for FedNow
    "_caseId": "CASE91000072",  //applicable only for TCH
    "reason": {
        "code": "AC03",
        "additionalInfo": "Test Information"
    }
    "returnRequestDetails": {  //applicable only for FedNow
        "email": "ramesh@test.com",
        "name": "Ramesh P",
        "phoneNo": "+19-856475852",
        "prefMethod": "PHON"
    }
}

Response: 200

Response Parameters

Parameter	Description
response	String Response received for the given request Example – "JSON Representation of Received Response"
message	String Notification message for the request Example – "request submitted successfully"
rawMessage	String Raw response message related to the transaction encoded in Base64 Example – "Base64 Value of Received Response"
status	String Status of the response Example – "RCVD"
caseId (Applicable only for TCH)	String Response Case ID of the request Example – "M20240328026013673T1BT3021616703611"

Response Body (Applicable for both FedNow and TCH)

{
  "response": "JSON Representation of Received Response",
  "message": "request submitted successfully",
  "rawMessage": "Base64 Value of Received Response",
  "status": "RCVD",
  "caseId": "M20240328026013673T1BT3021616703611"  //applicable only for TCH
}